/**
  * @(#)ConcretelyAnnouncable.java
  *
  * Provide an interface for informing application components that a
  * 	course instance may have some missing information.
  * 
  * @author Course Scheduler Team
  * 
  * @license GNU General Public License version 3 (GPLv3)
  *
  * This file is part of Course Scheduler, an open source, cross platform
  * course scheduling tool, configurable for most universities.
  *
  * Copyright (C) 2010-2012 Course Scheduler Team
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  * 
  */
package com.pollicitus.scheduler.model;

/**
 * Interface for indicating if the downloaded course information is complete
 * 	or if there is more information which is "yet to be announced".
 * 
 * @author Course Scheduler Team
 *
 */
public interface ConcretelyAnnouncable {

	/**
	 * The most recent revision in which this file was changed in the source control system
	 */
	public static final String _revision = "$LastChangedRevision: 539 $";
	
	/**
	 * The date on which this file was last changed and submitted to source control
	 */
	public static final String _date = "$LastChangedDate: 2011-11-19 23:14:16 -0500 (Sat, 19 Nov 2011) $";
	
	/**
	 * The user which last changed the file and committed the change to source control
	 */
	public static final String _author = "$LastChangedBy: mike@pollicitus.com $";
	
	/**
	 * The URL which can be used to access this specific file within the source control system
	 */
	public static final String _headURL = "$HeadURL: https://courseschedulerx.googlecode.com/svn/trunk/course-scheduler/course-scheduler-core/src/main/java/com/pollicitus/scheduler/model/ConcretelyAnnouncable.java $";
	
	/**
	 * The source control file ID, comprised of the file name, latest revision, last changed date, and submitting user.
	 */
	public static final String _id = "$Id: ConcretelyAnnouncable.java 539 2011-11-20 04:14:16Z mike@pollicitus.com $";
	
	/**
	 * Returns true if all of the necessary information is present
	 * 
	 * @return if the object is concrete
	 */
	public boolean isConcretelyAnnounced();
	
	/**
	 * By definition, this must return !isConcretelyAnnounced()
	 * 
	 * @return if the object is non-concrete
	 */
	public boolean isToBeAnnounced();
}
